chore(docs): add normalized markdown table checker (prevent merge conflicts)#3460
Merged
Conversation
Contributor
Author
Code Review SummaryStatus: No Issues Found | Recommendation: Merge Executive SummaryFull review of 62 files across 2 commits — purely mechanical changes: a new markdown table enforcement script, CI workflow, Files Reviewed (62 files)TypeScript:
CI:
Config:
Documentation (new/updated sections):
Markdown files reformatted (58 files — mechanical table normalization only):
Reviewed by claude-4.6-sonnet-20260217 · 914,466 tokens Review guidance: REVIEW.md from base branch |
4b49ad9 to
5193fb2
Compare
alex-alecu
approved these changes
May 25, 2026
Contributor
alex-alecu
left a comment
There was a problem hiding this comment.
I would have liked it being split in 2 commits:
- Implement CI check
- Apply formatter to existing files
So I could review just the first commit
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
script/check-md-table-padding.ts(adapted from kilocode) to enforce compact, non-padded markdown tables across the repo*.mdto.prettierignoreso prettier won't re-pad table cells and create spurious diffs.github/workflows/check-md-table-padding.yml) that runs the check on every PR touching markdown filesAGENTS.mdunder a new "Markdown Tables" section--fixThe root cause of the problem: prettier aligns table cells by column width, so any content change causes every row in the table to be re-padded, polluting diffs with unrelated whitespace changes. Excluding
*.mdfrom prettier and enforcing compact table format prevents this entirely.Verification
bun run script/check-md-table-padding.ts— should report 132 file(s) checked, no padded tables found..github/workflows/check-md-table-padding.yml.Visual Changes
N/A
Reviewer Notes
The
skip()function in the script excludes only.changeset/,CHANGELOG.md, andnode_modules/— all other tracked*.mdfiles are checked. The kilocode version also skippedpackages/(fork upstream) and.opencode/glossary/(translator-readable aligned tables), neither of which apply to this repo.